/*
 * Copyright 2002-2014 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.ideacome.test.common.mock.interceptor;

import org.springframework.cache.CacheManager;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.cache.interceptor.CacheErrorHandler;
import org.springframework.cache.interceptor.CacheResolver;
import org.springframework.cache.interceptor.KeyGenerator;

/**
 * 配置mocking
 *
 * @author 罗成
 */
public interface MockingConfigurer {

    /**
     * Return the cache manager bean to use for annotation-driven cache
     * management. A default {@link CacheResolver} will be initialized
     * behind the scenes with this cache manager. For more fine-grained
     * management of the cache resolution, consider setting the
     * {@link CacheResolver} directly.
     * <p>Implementations must explicitly declare
     * {@link org.springframework.context.annotation.Bean @Bean}, e.g.
     * <pre class="code">
     * &#064;Configuration
     * &#064;EnableCaching
     * public class AppConfig extends CachingConfigurerSupport {
     * &#064;Bean // important!
     * &#064;Override
     * public CacheManager cacheManager() {
     * // configure and return CacheManager instance
     * }
     * // ...
     * }
     * </pre>
     * See @{@link EnableCaching} for more complete examples.
     */
    CacheManager cacheManager();

    /**
     * Return the {@link CacheResolver} bean to use to resolve regular caches for
     * annotation-driven cache management. This is an alternative and more powerful
     * option of specifying the {@link CacheManager} to use.
     * <p>If both a {@link #cacheManager()} and {@link #cacheResolver()} are set, the
     * cache manager is ignored.
     * <p>Implementations must explicitly declare
     * {@link org.springframework.context.annotation.Bean @Bean}, e.g.
     * <pre class="code">
     * &#064;Configuration
     * &#064;EnableCaching
     * public class AppConfig extends CachingConfigurerSupport {
     * &#064;Bean // important!
     * &#064;Override
     * public CacheResolver cacheResolver() {
     * // configure and return CacheResolver instance
     * }
     * // ...
     * }
     * </pre>
     * See {@link EnableCaching} for more complete examples.
     */
    CacheResolver cacheResolver();

    /**
     * Return the key generator bean to use for annotation-driven cache management.
     * Implementations must explicitly declare
     * {@link org.springframework.context.annotation.Bean @Bean}, e.g.
     * <pre class="code">
     * &#064;Configuration
     * &#064;EnableCaching
     * public class AppConfig extends CachingConfigurerSupport {
     * &#064;Bean // important!
     * &#064;Override
     * public KeyGenerator keyGenerator() {
     * // configure and return KeyGenerator instance
     * }
     * // ...
     * }
     * </pre>
     * See @{@link EnableCaching} for more complete examples.
     */
    KeyGenerator keyGenerator();

    /**
     * Return the {@link CacheErrorHandler} to use to handle cache-related errors.
     * <p>By default,{@link org.springframework.cache.interceptor.SimpleCacheErrorHandler}
     * is used and simply throws the exception back at the client.
     * <p>Implementations must explicitly declare
     * {@link org.springframework.context.annotation.Bean @Bean}, e.g.
     * <pre class="code">
     * &#064;Configuration
     * &#064;EnableCaching
     * public class AppConfig extends CachingConfigurerSupport {
     * &#064;Bean // important!
     * &#064;Override
     * public CacheErrorHandler errorHandler() {
     * // configure and return CacheErrorHandler instance
     * }
     * // ...
     * }
     * </pre>
     * See @{@link EnableCaching} for more complete examples.
     */
    CacheErrorHandler errorHandler();

    /**
     * 是否需要启动mock，如果是生产建议配置false
     *
     * @return
     */
    boolean needMock();

    /**
     * 读取key默认前缀 建议使用（工程名+冒号）
     *
     * @return
     */
    String keyPrefix();
}
